home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / psizzl / psizzl.commands < prev    next >
Text File  |  1992-08-26  |  13KB  |  313 lines
  1.   PSIZZL COMMANDS - reference manual
  2.  
  3.              Reference guide to Psizzl macros
  4.  This is a list of all the user macros in Psizzl.
  5.  They are grouped logically according to function.
  6.  
  7. MACROS
  8.  
  9. These macros are general-purpose macros used
  10. everywhere in Psizzl, or are of general interest.
  11.     \Psizzl - this gives the logo: Psizzl
  12.     \diagnostics - turns on tracing diagnostics
  13.     \endpage - causes a page break
  14.     \underscore#1 -
  15.        gives the argument, \underscore{{\it underscored}}
  16.     \leaderfil - gives leaders of dots:\hbox to 1in{(\leaderfil)}
  17.     \centertitle#1 - along with |\breaktitle|, below, gives a centered
  18.        title, whose line breaks are controlled by the user
  19.     \breaktitle - to be used with |\centertitle| to break the lines
  20.     \monthdayyear - causes the date used in \Psizzl macros to appear
  21.        as {\sl ``month day, year''}, instead of {\sl ``day month year''},
  22.        which is the default.
  23.     \date#1 - sets the date to the argument. See also  |\letterdate| and
  24.           |\pubdate|.
  25.     \loosepar - To be used to terminate any paragraph which
  26.        has an overfull |\hbox|, due to the line breaker not working.
  27.     \unlock - To ``unlock'' the macros, so that the character `|@|'
  28.        may be used in macro names.
  29.     \lock - To undo |\unlock|.
  30.  
  31.     \adddef#1#2 - adds #2 to the \def of #1
  32.     \bumpcount#1 - increases the absolute value of \count#1 by 1
  33.     \numorroman#1 - expands to arabic if \count#1 is positive, and to
  34.        roman if \count#1 is negative
  35.     \lapcomma - gives a comma which will overlap the chracter to the left
  36.     \translate#1#2#3 - causes TeX to typeset the object specified by #3
  37.        at the postion specified by X = #1 and Y = #2 relative to the
  38.        current postion. The current position is not, however, changed.
  39.     \iftemp  - this is a `scratch' switch. It can be used at any time.
  40.  
  41. LISTS
  42.  
  43. These are the macros pertaining to lists.
  44.     \itembegin#1 - Starts an itemized list and sets the symbol to the
  45.        argument.
  46.     \item - Makes an entry in an itemized list with the current symbol.
  47.     \itemcon - Continues an item in a list starting with a new paragraph.
  48.     \itemset#1 - sets the symbol to #1, but does not begin an item.
  49.  
  50.     \sitembegin#1 - Similar to |\itembegin|, for a subitem.
  51.     \sitem - Similar to |\item|, for a subitem.
  52.     \sitemcon - Similar to |\itemcon|, for subitem.
  53.     \sitemset#1 - Similar to |\itemset|, for a subitem.
  54.  
  55.     \ssitembegin#1 - Similar to |\itembegin|, for a subsubitem.
  56.     \ssitem - Similar to |\item|, for a subsubitem.
  57.     \ssitemcon - Similar to |\itemcon|, for subsubitem.
  58.     \ssitemset#1 - Similar to |\itemset|, for a subsubitem.
  59.  
  60.     \pointbegin - Start a sequential list of points.
  61.     \point - Put another item in a seqential list.
  62.     \pointcon - Like |\itemcon| for a sequentail list.
  63.  
  64.     \spointbegin - Like |\pointbegin|, for a sublist.
  65.     \spoint - Like |\point|, for a sublist.
  66.     \spointcon - Like |\pointcon|, for a sublist.
  67.  
  68.     \sspointbegin - Like |\pointbegin|, for a subsublist.
  69.     \sspoint - Like |\point|, for a subsublist.
  70.     \sspointcon - Like |\pointcon|, for a subsublist.
  71.  
  72. PICTURE
  73. These macros facilitate making pictures.
  74.      \blankbox#1#2 - Makes a blank box of the specified dimensions.
  75.      \scalein - An inch dimension which magnifies with the type size.
  76.      \boxit#1 - Put a box around the argument.
  77.      \picture#1#2 - Currently just |\blankbox|.
  78.  
  79. FONTDEFS
  80. These define the fonts used in \Psizzl.
  81. % `X' denotes that the font is loaded
  82. % suffixes:   rm  ss  fib  i it  bf  sy  sl  ss  tt  x  caps
  83. % prefixes:
  84. % \twelve      X   X       X  X   X   X   X   X   X  X    X
  85. % \ten         X   X       X  X   X   X   X   X   X  X    X
  86. % \eight       X           X      X   X   X
  87. % \seven       X           X      X   X
  88. % \five        X           X      X   X
  89.  
  90. % e.g.: \twelverm is a roman font at 12 point
  91. %       \tencaps  is a cap/smallcap font at 10 pt
  92.  
  93. % Plus the following special fonts:
  94. %    \fortyss
  95. %    \fifteenrm
  96. %    \fourteenrm
  97. %    \tenex
  98. The following macros are defined in this file:
  99.  
  100.      \singlespace - Set to single spaced lines.
  101.      \normalbaselines - Set to one-and-one-half spaced lines.
  102.      \doublespace - Set to double spaced lines.
  103.      \largetype - Set to large type size.
  104.      \mediumtype - Set to medium type size.
  105.  
  106. OPTIONS
  107. These macros turn on various switches, which control how
  108. certain options are used in \Psizzl depending on what publication
  109. you are writing for.
  110.  
  111.     \APS - American Physical Society.
  112.     \IEEE - IEEE.
  113.     \NIM - Nuclear Instruments and Methods.
  114.     \NPB - Nuclear Physics B.
  115.     \PRL - Phys. Rev. Letters.
  116.     \PRD - Phys. Rev. D.
  117.     \PL - Physics Letters.
  118.     \illn#1 - when in |\proof| mode, it expands to ``Illn. #''
  119.     \draft - Specifies that this is a draft.
  120.     \preprint - Specifies that this is a preprint.
  121.     \proof - Specifies that this is a proof copy.
  122.     \submit - Specifies that this will be submitted to a journal.
  123.     \foreign - selects specifications for non-APS journals
  124.     \journal - selects specifications for journal articles
  125.     \conference - selects specifications for conference proceedings
  126.     \ifdraft - flag: this is the draft style of a document
  127.     \ifproof - flag: this is the proof style of a document
  128.     \ifsubmit - flag: this is the submit style of a document
  129.  
  130. OUTPUT
  131. These macros control how the output will appear on the page.
  132.    \ifdoubleside - flag: the document will be double sided
  133.    \ifquadside - flag: the document will be two-pages-per-leaf
  134.  
  135. PUBLICAT
  136. These macros generate the title page of a publication,
  137. and indirectly invoke some switches.
  138.     \docspec#1 - document specifications. Appear in upper right of title
  139.         page
  140.     \contract#1 - Defines the contract to be cited.
  141.     \contracttrue - Specifies that the given contract is to be cited.
  142.     \title#1 - Title of the document.
  143.     \subtitle#1 - specify the subtitle of a document.
  144.     \authors#1 - Author list.
  145.     \institute#1 - The publishing institution.
  146.     \submittedto#1 - The journal to be submitted to.
  147.     \abstract#1 - The abstract.
  148.     \university#1 - Specify the university of the thesis student
  149.     \price#1 - Specify the price code of NTIS
  150.     \workingauthor#1 - Specify the working author.
  151.     \workingauthorbin#1 - Specify the mail stop of the working author.
  152.     \workingauthoraddress#1
  153.         {Specify the address of the workin g author.
  154.     \publicationstyle#1 - macros to be invoked at the beginning of the
  155.          publication
  156.     \publication - specify that document will be a publication
  157.     \thesisstyle#1 - macros to be invoked at the beginning of the thesis.
  158.     \thesis - specify that document will be a thesis
  159.     \reportstyle#1 - macros to be invoked at the beginning of a report.
  160.     \report - specify that document will be a report
  161.     \acknowledge#1 - specify the text of the acknowledgement
  162.     \begindocument - begin production of the specified document.
  163.        Title page, etc. are produced now.
  164.     \enddocument - end production of the document.
  165.     \sigpage#1#2#3#4#5 - specify details of signature page of a thesis.
  166.     \iffrontmatter - flag: the front matter of the document is to be
  167.         produced.
  168.     \ifabstractsigned - flag: the abstract page is to be signed.
  169.     \ifcopyright - flag: this document is to be copyrighted.
  170.  
  171. MEMO
  172. These macros will cause a memo to be produced.
  173.     \memohead#1 - Specify the header of the memo.
  174.        Default is institution-dependent
  175.     \memodate#1 - Specify the date of the memo.
  176.     \memoto#1 - Who the memo is to.
  177.     \memofrom#1 - Who the memo is from.
  178.     \memosubject#1 - Specify the topic of the memo.
  179.     \beginmemo - To begin the memo.
  180.     \endmemo - To end the memo.
  181.     \memostyle#1 - Specify the style of the memo.
  182.  
  183. LETTER
  184. These macros control how letters are made.
  185.     \letterdate#1 - Specify the date of the letter.
  186.     \salutation#1 - Specify the salutation.
  187.     \closing#1 - Specify the closing.
  188.     \typist#1 - Specify the initials of the typist.
  189.     \copiesto#1 - Specify the cc:
  190.     \MyRef#1 - Specify your reference number.
  191.     \YourRef#1 - Specify the receiver's reference number.
  192.     \breakletter - Break the page at this point.
  193.     \letterto#1#2 - Name and address of the receiver.
  194.     \letterfrom#1#2#3 - Specify the sender.
  195.     \everyletter#1 - Text to be included in every letter.
  196.     \beginletter - Begin the letter.
  197.     \endletter - End the letter.
  198.     \letterhead#1#2#3#4 - Specify the letterhead.
  199.     \postscript#1 - specify the postscript of the letter
  200.     \enclosure#1#2 - specify the enclosures of the letter
  201.     \prescript#1 - specify the prescript of the letter
  202.     \letterstyle#1 - macros to be invoked at the start of the letter
  203.     \ifletter - flag: for output routine: this is a letter
  204.     \ifletterhead - flag: a letterhead is to be produced. Default: true
  205.     \ifstreetaddress - flag: the street address of the institution
  206.        is to appear in the letterhead. default: false.
  207.     \ifwindowenvelope - flag: the address of the letter will be typeset
  208.        so that it will appear within the window of a window envelope.
  209. CHAPTERS
  210. The body of a document (be it publication, memo, or letter)
  211. are produced by these macros.
  212.     \beginbody - Begin the body of the paper.
  213.     \chapter#1 - Begin a new chapter.
  214.     \beginappendices - Subsequent |\chapter|s will be appendices.
  215.     \endbody - End the body. Get out list of references, \etc
  216.     \section#1 - Start a bew section.
  217.     \subsection#1 - Start a new subsection.
  218.     \subsubsection#1 - Start a new subsubsection.
  219.  
  220. CITATION
  221. Citations such as references, figures, tables and equations are
  222. done by these macros.
  223.  
  224. In the following macros,
  225. #1 is a valid TeX control squence name
  226. (`\' followed by alphabetic characters only: don't use any numerals!).
  227.  
  228. Where the macros use `=', they are defining the mnemonic name, so
  229. \<NAME> must not have been previously defined. (Hint: use some CAPITALS).
  230. Once this has been done, the mnemonic name can be used with the macro
  231. without the `=' and following one (or three) arguments:
  232. e.g.: first use: `\cite\DrellYan={Private communication}'
  233.       second use: `\Reference\DrellYan\ has clearly shown....'
  234.  
  235. In the reference, equation, and author address macros,
  236. #2 is the text of the respective thing being defined.
  237.  
  238.     REFERENCES:
  239.     The following three macros set the style of the reference:
  240.     \superreference - References will be superscripted: `$^{#1}$'
  241.     \bracketreference - References will appear in brackets: `[#1]'
  242.     \parenreference - References will appear in parenthesis: `(#1)'
  243.  
  244.     The following five macros define or cite references:
  245.     \cite#1=#2 - Define a new reference and put out, e.g.: `$^{#1}$'
  246.     \hideref#1=#2 - define a new reference, but don't put out any text.
  247.        This is how multiple references are produced.
  248.     \bareref#1=#2 - define a new reference, and put out #1 only (bare).
  249.     \reference#1=#2 - Define a new reference and put out `Ref.#1'
  250.     \Reference#1=#2 - Define a new reference and put out `Reference #1'
  251.  
  252.     \refspec#1,#2(#3)
  253.         Specify a reference in a way that the journal style can switch.
  254.     \volyearpageref - |\refspec| will be: volume, year, page.
  255.     \cernref - References will appear in CERN's style.
  256.  
  257.     EQUATIONS:
  258.     \equation#1=#2 - Define a new equation.
  259.     \Equation#1=#2 - Define a new equation.
  260.     \display#1=#2  - define a new equation and display it.
  261.  
  262.     AUTHOR ADDRESS SPECIFICATION:
  263.     \authoraddress#1=#2 - define a new authoraddress
  264.     \presentaddress#1=#2 - define a new authoraddress
  265.        as `Present address: #2'
  266.     \addressreference - specify author addresses to be references
  267.     \addressfootnote - specify author addresses to be footnotes
  268.     \addressinline - specify author addresses to be inline
  269.  
  270.     In the figure and table macros,
  271.     #2 is the title of the figure or table, which will appear in the
  272.     table of contents.
  273.     #2 and #3 concatenated together constitute the caption of the figure
  274.     or table.
  275.     #4 will be the contents of the figure or table itself.
  276.  
  277.     FIGURES:
  278.     \figure#1=#2#3#4 - Define a new figure and put out `Fig.#1'
  279.     \Figure#1=#2#3#4 - Define a new figure and put out `Figure #1'
  280.     \iffigureembed - figures are to be imbedded into the text.
  281.        Default: true.
  282.  
  283.     TABLES:
  284.     \table#1=#2#3#4 - Define a new table and put out `table #1'
  285.     \Table#1=#2#3#4 - Define a new table and put out `table #1'
  286.     \iftableembed - tables are to be embedded into the text.
  287.        Default: true.
  288.  
  289.     MISC:
  290.     \hangpar#1#2 - starts a paragraph with hanging indentation.
  291.     \lowercasecite - Citations will be lower case, not upper.
  292.     \vita#1 - specify a curriculum vitae for this document
  293.     \hyphen - punctuation for equations and multiple references
  294.     \comma  - punctuation for multiple references
  295.     \lapperiod - a period which overlaps to the left.
  296.  
  297.  
  298. VERBATIM
  299. These are the macros for verbatim scanning.
  300.      \begintt - Begin verbatim mode.
  301.      \endtt - End verbatim mode.
  302.      |stuff| - Verbatim mode, inline.
  303.      \listfile#1 - Make a listing of the specified file.
  304.      \iflistnumber - flag: \listfile produces a numbered listing.
  305.  
  306. INDEX
  307. These are the macros for doing the index of a document.
  308. They can each turn into a ``silent'' index entry by doubling the `^'
  309.    ^\{text} - Ordinary index entry.
  310.    ^\|text| - A special term, index entry.
  311.    ^\|\text| - A control sequence, index entry.
  312.    ^\<text> - A bracketed concept, index entry.
  313.